Step-by-step instructions for setting up Raspberry Pi Connect.
These procedures apply to Raspberry Pi 5, 4 or 3 with Raspberry Pi OS (64-Bit), (32-Bit) or (Legacy, 32-Bit).
General Notes
1. General:
The procedures below are optimized for setting up Raspberry Pi Connect on a Raspberry Pi 5, 4 or 3 with Raspberry Pi OS (64-Bit), (32-Bit) or (Legacy, 32-Bit).
2. Raspberry Pi Connect:
Raspberry Pi Connect runs on Raspberry Pi OS Raspberry Pi OS bookworm (debian 12), trixie (debian 13) and above. Older versions are not supported.
Raspberry Pi Connect is installed by default in newer Raspberry Pi OS bookworm (debian 12) installations, and all trixie (debian 13) and above installations.
Raspberry Pi Connect can be be setup during SD card setup using Raspberry Pi Imager 2.0, released in November 2025, and above.
3. Internet access during setup:
Many of the steps below assume and require the target Raspberry Pi is connected to a network with access to the Internet.
4. Important note about Raspberry Pi Connect and TeamViewer:
Both screen sharing programs can exist on a Raspberry Pi without interfering with each other,
but the Raspberry Pi Connect screen sharing program requires Wayland (Remote Graphics Support A.K.A. compositor) and TeamViewer currently uses only the older X11 (compositor).
Raspberry Pi Connect Remote shell does not use the compositor and will work with either compositor in use.
It is posable to switch between Wayland and X11, however a reboot may be required.
Raspberry Pi Connect is recommended for typical users, while TeamViewer may be more attractive to more experienced users.
Notice about updates, upgrades and installations failing due to repository or network congestion or outages
Occasionally updates, upgrades and installations fail due to repository or network congestion or outages.
Sometimes there is an appropriate message saying as such, sometimes a missing file is reported, and sometimes there is just a failure message without an explanation.
When this occurs, simply run the command again.
If that does not solve the issues immediately, try again later.
Connect to the target Raspberry Pi
Connect to the target Raspberry Pi using Raspberry Pi Connect Remote shell or Raspberry Pi Connect Screen share and open a Terminal window.